<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>mipi_rx_phy: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">mipi_rx_phy
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li class="current"><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">mipi_rx_phy Documentation</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This file contains the implementation of the MIPI mipi_rx_phy Controller driver.User documentation for the driver functions is contained in this file in the form of comment blocks at the front of each function.</p>
<p><b>MIPI mipi_rx_phy Overview</b></p>
<p>The mipi_rx_phy currently supports the MIPI?Alliance Specification for mipi_rx_phy Version 1.0.</p>
<p>It is capable of synchronous transfer at high speed mode at 80-1500 Mbps It has one clock lane and up to 4 data lanes. These lanes are unidirectional. It can do asynchronous transfer at upto 10 Mbps in low power mode. The clock lane can be in low power mode or high speed mode whereas the data lanes can be in Low power, High power or Escape mode.</p>
<p>The programmable parameters like IDelay, Wakeup, HS Timeout, Esc Timeout are present and various status like Stop state, Error detected, ULPS state,etc are available through the status register</p>
<p><b>Core Features</b></p>
<p>The GUI in IPI allows for the following configurations</p>
<ul>
<li>Lanes ( 1 to 4 )</li>
<li>Line Rate (80 - 1500 Mbps)</li>
<li>Data Flow direction (Tx or Rx)</li>
<li>Escape Clock (10 - 20 Mhz)</li>
<li>LPX period (50 - 100 ns)</li>
<li>Enable register interface</li>
<li>HS Timeout in Bytes (1000 - 65541)</li>
<li>Escape Timeout in ns (800 - 25600)</li>
</ul>
<p><b>Software Initialization &amp; Configuration</b></p>
<p>By default, the mipi_rx_phy core is initialized and ready.</p>
<p>The application needs to do following steps in order for preparing the MIPI mipi_rx_phy core to be ready.</p>
<ul>
<li>Call XMipi_Rx_Phy_LookupConfig using a device ID to find the core configuration.</li>
<li>Call XMipi_Rx_Phy_CfgInitialize to initialize the device and the driver instance associated with it.</li>
<li>Individual parameters can be configured by sending values with appropriate handles.</li>
</ul>
<p><b>Interrupts</b></p>
<p>There are no interrupts from the mipi_rx_phy.</p>
<p><b> Virtual Memory </b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
<p><b> Threads </b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b>Asserts</b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that application developers leave asserts on during development.</p>
<p><b>Building the driver</b></p>
<p>The mipi_rx_phy driver is composed of source files and doesn't depend on any other drivers.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver Who Date     Changes
</p>
<hr/>
<p>
1.0 pg 16/02/24 Initial release
</pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
